General Parameters
The general management parameters are described in the table below.
General Management Parameters
Parameter |
Description |
||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
'Web Server Name' configure system > web > web-hostname [WebHostname] |
Defines a hostname (FQDN) for the device's Web interface. This can be used to access the Web interface instead of the device's IP address. By default, no value is defined. For more information, see Configuring a Hostname for Accessing Web Interface. Note: If not configured, the device uses the [Hostname] parameter. |
||||||||||||||||||
'Enforce Web Host Name' configure system > web > enforce-web-host-name [EnforceWebHostname] |
Enables the enforcement of access to the device's Web interface through a hostname only, and blocks any attempt to access the Web interface through the device's IP address.
Note:
|
||||||||||||||||||
'Hostname' configure system > hostname [Hostname] |
Defines a hostname for the device, which is used for various functionality such as the CLI prompt name. The valid value is a string of up to 18 characters. By default, no value is defined. For more information, see Configuring a Hostname for the Device. Note: To configure a hostname for accessing the device's Web interface, use the [WebHostname] parameter. |
||||||||||||||||||
[WebLoginBlockAutoComplete] |
Disables autocompletion when entering the management login username in the 'Username' field of the device's Web interface. Disabling autocompletion may be useful for security purposes by hiding previously entered usernames and thereby, preventing unauthorized access to the device's management interface.
|
||||||||||||||||||
'Enforce Username Complexity' configure system > users-settings > enforce-username-complexity [EnforceUsernameComplexity] |
Enables the enforcement of username complexity.
For more information, see Configuring Username and Password Complexity. |
||||||||||||||||||
'Username Complexity Check By Regex' configure system > users-settings > username-complexity-check-by-regex [UsernameComplexityCheckByRegex] |
Defines a username complexity policy by a regular expression (regex). By default, no regex is defined. For more information, see Configuring Username and Password Complexity. |
||||||||||||||||||
'Enforce Password Complexity' configure system > users-settings > enforce-password-complexity |
Enables the enforcement of password complexity.
For more information, see Configuring Username and Password Complexity. |
||||||||||||||||||
'Password Complexity Check By Regex' configure system > users-settings > password-complexity-check-by-regex [PasswordComplexityCheckByRegex] |
Defines a password complexity policy by a regular expression (regex). By default, no regex is defined. For more information, see Configuring Username and Password Complexity. |
||||||||||||||||||
configure system > web > min-web-password-len [MinWebPasswordLen] |
Defines the minimum length (number of characters) of the management user's login password when password complexity is enabled. The valid value is a string of 8 to 20 characters. The default is 8. Note: To enable password complexity, use the [EnforcePasswordComplexity] parameter. |
||||||||||||||||||
configure system > web > check-password-history [CheckPasswordHistory] |
Enables the device to enforce password history policy (reuse an old password), which prohibits a user from changing its password to any of the user's four previous passwords.
Note: The parameter is not applicable to the password for the CLI privileged mode (> enable). |
||||||||||||||||||
'Use OAuth for Web Login' configure system > mgmt-auth > oauth-web-login [OAuthWebLogin] |
Enables user login authentication based on OAuth 2.0.
For more information, see Enabling OAuth-based User Login Authentication. |
||||||||||||||||||
'Local Users Table can be Empty' configure system > web > local-users-table-can-be-empty [AllowRemoveLocalUsersTable] |
Enables (allows) the deletion of all users in the Local Users table (see Configuring Management User Accounts). This is used when an external, third-party service (e.g., LDAP. RADIUS, or OAuth) is used to authenticate users.
For more information, see Deleting All Users in Local Users Table. |
||||||||||||||||||
'Lock' admin state lock [AdminState] |
Locks the device, whereby existing calls are terminated (optionally, after a graceful period) and new calls are rejected.
For more information, see Locking and Unlocking the Device. |
||||||||||||||||||
'Graceful Option' admin state lock graceful [AdminStateLockControl] |
Defines a graceful period (in seconds) before the device locks. During this period, the device doesn't accept any new calls, allowing only existing calls to continue until the timeout expires. If all existing calls end before the timeout expires, the device locks. If there are still existing calls when the timeout expires, the device terminates them and then locks. The valid value is 0 to 32,768 seconds. The default is 0, meaning no graceful lock (i.e., immediate lock). A value of -1 means that the device locks only after all the existing calls end (on their own accord). For more information, see Locking and Unlocking the Device. |
||||||||||||||||||
configure troubleshoot > max-startup-fail-attempts [MaxStartupFailAttempts] |
Defines the number of consecutive failed device restarts (boots), after which the device automatically restores its software and configuration based on (by loading) the default System Snapshot. The valid value is 1 to 10. The default is 6. For more information, see Rescue Options using System Snapshots. |
||||||||||||||||||
'Disconnect Client Connections' admin state lock no-graceful disconnect-client-connections [AdminStateRestrictConnections] |
Enables the device to close existing TLS/TCP client connections and reject incoming TLS/TCP client connections when the device is in locked state.
For more information, see Locking and Unlocking the Device. |
||||||||||||||||||
'Floating License' configure system > floating-license > floating-license [EnableFloatingLicense] |
Enables the device to operate with the Floating License.
For more information, see Floating License Model. Note: For the parameter to take effect, a device restart is required. |
||||||||||||||||||
'Allocation Profile' configure system > floating-license > allocation-profile [AllocationProfile] |
Defines an SBC capacity profile (Allocation Profile) for the Floating License feature.
Note: For the parameter to take effect, a device restart is required. |
||||||||||||||||||
'Allocation - Far End Users' configure system > floating-license > allocation-registered-users [AllocationRegisteredUsers] |
Defines registered users capacity for a customized Allocation Profile for the Floating License feature. Note:
|
||||||||||||||||||
'Allocation – SBC Media Sessions' configure system > floating-license > allocation-media-sessions [AllocationMediaSessions] |
Defines SBC media session capacity for a customized Allocation Profile for the Floating License feature. Note:
|
||||||||||||||||||
'Allocation – SBC Signaling Sessions' configure system > floating-license > allocation-signaling-sessions [AllocationSignalingSessions] |
Defines SBC signaling session capacity for a customized Allocation Profile for the Floating License feature. Note:
|
||||||||||||||||||
'Allocation – WebRTC Sessions' configure system > floating-license > allocation-webrtc-sessions [AllocationWebRTCSessions] |
Defines WebRTC session capacity for a customized Allocation Profile for the Floating License feature. Note:
|
||||||||||||||||||
'Allocation – SIPREC Streams' configure system > floating-license > allocation-siprec-sessions [AllocationSIPRecStreams] |
Defines SIPREC session capacity for a customized Allocation Profile for the Floating License feature. Note:
|
||||||||||||||||||
'Limit - Far End Users' configure system > floating-license > limit-registered-users [LimitRegisteredUsers] |
Defines a limit of the registered user capacity for a customized Allocation Profile for the Floating License feature. Note: The parameter is applicable only when the 'Allocation Profile' is configured to Custom. |
||||||||||||||||||
'Limit – SBC Media Sessions' configure system > floating-license > limit-media-sessions [LimitMediaSessions] |
Defines a limit of the SBC media session capacity for a customized Allocation Profile for the Floating License feature. Note: The parameter is applicable only when the 'Allocation Profile' is configured to Custom. |
||||||||||||||||||
'Limit – SBC Signaling Sessions' configure system > floating-license > limit-signaling-sessions [LimitSignalingSessions] |
Defines a limit of the SBC SIP signaling session capacity for a customized Allocation Profile for the Floating License feature. Note: The parameter is applicable only when the 'Allocation Profile' is configured to Custom. |
||||||||||||||||||
'Limit – Transcoding Sessions' configure system > floating-license > limit-transcoding-sessions [LimitTranscodingSessions] |
Defines a limit of the transcoding session capacity for a customized Allocation Profile for the Floating License feature. Note: The parameter is applicable only when the 'Allocation Profile' is configured to Custom. |
||||||||||||||||||
'Limit – WebRTC Sessions' configure system > floating-license > limit-webrtc-sessions [LimitWebRTCSessions] |
Defines a limit of the WebRTC session capacity for a customized Allocation Profile for the Floating License feature. Note: The parameter is applicable only when the 'Allocation Profile' is configured to Custom. |
||||||||||||||||||
'Limit – SIPREC Streams' configure system > floating-license > limit-siprec-sessions [LimitSIPRecStreams] |
Defines a limit of the SIPREC session capacity for a customized Allocation Profile for the Floating License feature. Note: The parameter is applicable only when the 'Allocation Profile' is configured to Custom. |
||||||||||||||||||
'Metering Interface Name' configure system > metering > metering-client [MeteringClientInterface] |
Defines the network interface (e.g., eth1) that is associated with the Elastic IP address for the Metered License model when the device is deployed in the Amazon Web Services (AWS) cloud. For more information, see SBC Capacity License from Metered License. Below shows an example of the ini file format: [MeteringClientInterface] |
||||||||||||||||||
'Product Key' configure system > product-key [ProductKey] |
Defines the device's Product Key. The valid value is a string of up to 40 characters. |
||||||||||||||||||
configure troubleshoot > startup-n-recovery > system-console-mode [SystemConsoleMode] |
Defines the console access mode.
Note: For the parameter to take effect, a device restart is required. |
||||||||||||||||||
[CustomerSN] |
Defines a serial number (S/N) for the device. Note: The device's original S/N is automatically added at the end of the configured S/N. For example, if the original S/N is 8906721 and the configured S/N is "abc123", the resultant S/N is "abc1238906721". |